<meta charset="utf-8">
(#) ProtoLayout Material PrimaryLayout should be used with responsive behaviourto ensure the best behaviour across different screen sizes and locales

!!! WARNING: ProtoLayout Material PrimaryLayout should be used with responsive behaviourto ensure the best behaviour across different screen sizes and locales
   This is a warning.

Id
:   `ProtoLayoutPrimaryLayoutResponsive`
Summary
:   ProtoLayout Material PrimaryLayout should be used with responsive behaviourto ensure the best behaviour across different screen sizes and locales
Severity
:   Warning
Category
:   Correctness
Platform
:   Android
Vendor
:   Android Open Source Project
Identifier
:   androidx.wear.protolayout
Feedback
:   https://issuetracker.google.com/issues/new?component=1112273
Min
:   Lint 8.7+
Compiled
:   Lint 8.7+
Artifact
:   [androidx.wear.protolayout:protolayout](androidx_wear_protolayout_protolayout.md.html)
Since
:   1.2.0
Affects
:   Kotlin and Java files
Editing
:   This check runs on the fly in the IDE editor
Implementation
:   [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/wear/protolayout/protolayout-lint/src/main/java/androidx/wear/protolayout/lint/ResponsiveLayoutDetector.kt)
Tests
:   [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/wear/protolayout/protolayout-lint/src/test/java/PrimaryLayoutResponsiveDetectorTest.kt)
Copyright Year
:   2024

It is highly recommended to use the latest
setResponsiveInsetEnabled(true) when you're
using the ProtoLayout's PrimaryLayout.

This is will take care of all inner padding to ensure that content of
labels and bottom
chip doesn't go off the screen (especially with different locales).

!!! Tip
   This lint check has an associated quickfix available in the IDE.

(##) Example

Here is an example of lint warnings produced by this check:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
src/foo/Bar.kt:4:Warning: PrimaryLayout used, but responsiveness isn't
set: Please call
setResponsiveContentInsetEnabled(true) for the best results across
different screen sizes. [ProtoLayoutPrimaryLayoutResponsive]
val layout = PrimaryLayout.Builder(null)
             ---------------------
src/foo/Bar.kt:9:Warning: PrimaryLayout used, but responsiveness isn't
set: Please call
setResponsiveContentInsetEnabled(true) for the best results across
different screen sizes. [ProtoLayoutPrimaryLayoutResponsive]
 val layout = PrimaryLayout.Builder(null)
              ---------------------
src/foo/Bar.kt:12:Warning: PrimaryLayout used, but responsiveness isn't
set: Please call
setResponsiveContentInsetEnabled(true) for the best results across
different screen sizes. [ProtoLayoutPrimaryLayoutResponsive]
 val layoutFalse = PrimaryLayout.Builder(null)
                   ---------------------
src/foo/Bar.kt:17:Warning: PrimaryLayout used, but responsiveness isn't
set: Please call
setResponsiveContentInsetEnabled(true) for the best results across
different screen sizes. [ProtoLayoutPrimaryLayoutResponsive]
    val l = PrimaryLayout.Builder(null)
            ---------------------
src/foo/Bar.kt:24:Warning: PrimaryLayout used, but responsiveness isn't
set: Please call
setResponsiveContentInsetEnabled(true) for the best results across
different screen sizes. [ProtoLayoutPrimaryLayoutResponsive]
    PrimaryLayout.Builder().setResponsiveContentInsetEnabled(enabled)
    ---------------------
src/foo/Bar.kt:32:Warning: PrimaryLayout used, but responsiveness isn't
set: Please call
setResponsiveContentInsetEnabled(true) for the best results across
different screen sizes. [ProtoLayoutPrimaryLayoutResponsive]
    return PrimaryLayout.Builder().build()
           ---------------------
src/foo/Bar.kt:36:Warning: PrimaryLayout used, but responsiveness isn't
set: Please call
setResponsiveContentInsetEnabled(true) for the best results across
different screen sizes. [ProtoLayoutPrimaryLayoutResponsive]
    PrimaryLayout.Builder()
    ---------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Here is the source file referenced above:

`src/foo/Bar.kt`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers
package foo
import androidx.wear.protolayout.material.layouts.PrimaryLayout

val layout = PrimaryLayout.Builder(null)
        .setResponsiveContentInsetEnabled(false)
        .build()

class Bar {
 val layout = PrimaryLayout.Builder(null)
        .build()

 val layoutFalse = PrimaryLayout.Builder(null)
            .setResponsiveContentInsetEnabled(false)
        .build()

    fun buildFalse() {
        val l = PrimaryLayout.Builder(null)
            .setResponsiveContentInsetEnabled(false)
        return l.build()
    }

    fun update() {
        val enabled = false
        PrimaryLayout.Builder().setResponsiveContentInsetEnabled(enabled)
    }

    fun build() {
        update().build()
    }

    fun build2() {
        return PrimaryLayout.Builder().build()
    }

    fun doubleFalse() {
        PrimaryLayout.Builder()
            .setResponsiveContentInsetEnabled(true)
            .setResponsiveContentInsetEnabled(false)
    }
}
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also visit the
[source code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/wear/protolayout/protolayout-lint/src/test/java/PrimaryLayoutResponsiveDetectorTest.kt)
for the unit tests for this check to see additional scenarios.

The above example was automatically extracted from the first unit test
found for this lint check, `ResponsiveLayoutDetector.primaryLayout without responsiveness requires and fixes setter`.
To report a problem with this extracted sample, visit
https://issuetracker.google.com/issues/new?component=1112273.

(##) Including

!!!
   This is not a built-in check. To include it, add the below dependency
   to your project.

```
// build.gradle.kts
implementation("androidx.wear.protolayout:protolayout:1.3.0-alpha05")

// build.gradle
implementation 'androidx.wear.protolayout:protolayout:1.3.0-alpha05'

// build.gradle.kts with version catalogs:
implementation(libs.protolayout)

# libs.versions.toml
[versions]
protolayout = "1.3.0-alpha05"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
protolayout = {
    module = "androidx.wear.protolayout:protolayout",
    version.ref = "protolayout"
}
```

1.3.0-alpha05 is the version this documentation was generated from;
there may be newer versions available.

NOTE: These lint checks are **also** made available separate from the main library.
Use one of the following artifacts:
* `androidx.wear.protolayout:protolayout-expression:1.3.0-alpha05`
* `androidx.wear.protolayout:protolayout-material3:1.3.0-alpha05`
* `androidx.wear.protolayout:protolayout-material:1.3.0-alpha05`


[Additional details about androidx.wear.protolayout:protolayout](androidx_wear_protolayout_protolayout.md.html).
(##) Suppressing

You can suppress false positives using one of the following mechanisms:

* Using a suppression annotation like this on the enclosing
  element:

  ```kt
  // Kotlin
  @Suppress("ProtoLayoutPrimaryLayoutResponsive")
  fun method() {
     Builder(...)
  }
  ```

  or

  ```java
  // Java
  @SuppressWarnings("ProtoLayoutPrimaryLayoutResponsive")
  void method() {
     new Builder(...);
  }
  ```

* Using a suppression comment like this on the line above:

  ```kt
  //noinspection ProtoLayoutPrimaryLayoutResponsive
  problematicStatement()
  ```

* Using a special `lint.xml` file in the source tree which turns off
  the check in that folder and any sub folder. A simple file might look
  like this:
  ```xml
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;lint&gt;
      &lt;issue id="ProtoLayoutPrimaryLayoutResponsive" severity="ignore" /&gt;
  &lt;/lint&gt;
  ```
  Instead of `ignore` you can also change the severity here, for
  example from `error` to `warning`. You can find additional
  documentation on how to filter issues by path, regular expression and
  so on
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).

* In Gradle projects, using the DSL syntax to configure lint. For
  example, you can use something like
  ```gradle
  lintOptions {
      disable 'ProtoLayoutPrimaryLayoutResponsive'
  }
  ```
  In Android projects this should be nested inside an `android { }`
  block.

* For manual invocations of `lint`, using the `--ignore` flag:
  ```
  $ lint --ignore ProtoLayoutPrimaryLayoutResponsive ...`
  ```

* Last, but not least, using baselines, as discussed
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>